<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SC2API: include/sc2api/sc2_gametypes.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="SC2-Logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SC2API
   </div>
   <div id="projectbrief">An API for AI for StarCraft II</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_3d0dfd3160b31ffa512c49330ac8d646.html">sc2api</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">sc2_gametypes.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="sc2__gametypes_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="sc2__common_8h.html">sc2_common.h</a>&quot;</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacesc2.html">sc2</a> {</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="keyword">typedef</span> uint64_t Tag;</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> Tag NullTag = 0LL;</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">enum</span> Race {</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;    Terran,</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    Zerg,</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;    Protoss,</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;    Random</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;};</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">enum</span> GameResult {</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;    Win,</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    Loss,</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;    Tie,</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    Undecided</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;};</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="keyword">enum</span> Difficulty {</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    VeryEasy = 1,</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    Easy = 2,</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    Medium = 3,</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    MediumHard = 4,</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    Hard = 5,</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    HardVeryHard = 6,</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    VeryHard = 7,</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    CheatVision = 8,</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    CheatMoney = 9,</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    CheatInsane = 10</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;};</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="keyword">enum</span> PlayerType {</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    Participant = 1,</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    Computer = 2,</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;    Observer = 3</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;};</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="keyword">class </span>Agent;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="structsc2_1_1_player_setup.html">   52</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_player_setup.html">PlayerSetup</a> {</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structsc2_1_1_player_setup.html#a59ec60d77794e16f2325a4bdbc693d89">   54</a></span>&#160;    PlayerType <a class="code" href="structsc2_1_1_player_setup.html#a59ec60d77794e16f2325a4bdbc693d89">type</a>;</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structsc2_1_1_player_setup.html#a46fd53bd97da279d423345b454823f2e">   56</a></span>&#160;    <a class="code" href="classsc2_1_1_agent.html">Agent</a>* <a class="code" href="structsc2_1_1_player_setup.html#a46fd53bd97da279d423345b454823f2e">agent</a>;</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <span class="comment">// Only used for Computer</span></div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structsc2_1_1_player_setup.html#aaa5c79519707f78fbe6f9f6d3580a051">   61</a></span>&#160;    Race <a class="code" href="structsc2_1_1_player_setup.html#aaa5c79519707f78fbe6f9f6d3580a051">race</a>;</div><div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="structsc2_1_1_player_setup.html#ac9616c686e3e31c2d8f9f023c9cd7dca">   63</a></span>&#160;    Difficulty <a class="code" href="structsc2_1_1_player_setup.html#ac9616c686e3e31c2d8f9f023c9cd7dca">difficulty</a>;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <a class="code" href="structsc2_1_1_player_setup.html">PlayerSetup</a>() :</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        type(Participant),</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        agent(nullptr),</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;        race(Terran),</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        difficulty(Easy) {</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    };</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <a class="code" href="structsc2_1_1_player_setup.html">PlayerSetup</a>(PlayerType in_type, Race in_race, <a class="code" href="classsc2_1_1_agent.html">Agent</a>* in_agent = <span class="keyword">nullptr</span>, Difficulty in_difficulty = Easy) :</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        <a class="code" href="structsc2_1_1_player_setup.html#a59ec60d77794e16f2325a4bdbc693d89">type</a>(in_type),</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;        <a class="code" href="structsc2_1_1_player_setup.html#a46fd53bd97da279d423345b454823f2e">agent</a>(in_agent),</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        <a class="code" href="structsc2_1_1_player_setup.html#aaa5c79519707f78fbe6f9f6d3580a051">race</a>(in_race),</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;        <a class="code" href="structsc2_1_1_player_setup.html#ac9616c686e3e31c2d8f9f023c9cd7dca">difficulty</a>(in_difficulty) {</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    }</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;};</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="structsc2_1_1_player_setup.html">PlayerSetup</a> CreateParticipant(Race <a class="code" href="structsc2_1_1_player_setup.html#aaa5c79519707f78fbe6f9f6d3580a051">race</a>, <a class="code" href="classsc2_1_1_agent.html">Agent</a>* <a class="code" href="structsc2_1_1_player_setup.html#a46fd53bd97da279d423345b454823f2e">agent</a>) {</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="structsc2_1_1_player_setup.html">PlayerSetup</a>(PlayerType::Participant, race, agent);</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;}</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="keyword">static</span> <span class="keyword">inline</span> <a class="code" href="structsc2_1_1_player_setup.html">PlayerSetup</a> CreateComputer(Race race, Difficulty <a class="code" href="structsc2_1_1_player_setup.html#ac9616c686e3e31c2d8f9f023c9cd7dca">difficulty</a> = Easy) {</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;    <span class="keywordflow">return</span> <a class="code" href="structsc2_1_1_player_setup.html">PlayerSetup</a>(PlayerType::Computer, race, <span class="keyword">nullptr</span>, <a class="code" href="structsc2_1_1_player_setup.html#ac9616c686e3e31c2d8f9f023c9cd7dca">difficulty</a>);</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;}</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;</div><div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="structsc2_1_1_port_set.html">   90</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_port_set.html">PortSet</a> {</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    <span class="keywordtype">int</span> game_port;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;    <span class="keywordtype">int</span> base_port;</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;    <a class="code" href="structsc2_1_1_port_set.html">PortSet</a>() :</div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;        game_port(-1),</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;        base_port(-1) {</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;    }</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;    <span class="keywordtype">bool</span> IsValid()<span class="keyword"> const </span>{</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;        <span class="keywordflow">return</span> game_port &gt; 0 &amp;&amp; base_port &gt; 0;</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    }</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;};</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;</div><div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="structsc2_1_1_ports.html">  105</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_ports.html">Ports</a> {</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;    <a class="code" href="structsc2_1_1_port_set.html">PortSet</a> server_ports;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;    std::vector&lt;PortSet&gt; client_ports;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;    <span class="keywordtype">int</span> shared_port;</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;    <a class="code" href="structsc2_1_1_ports.html">Ports</a>() :</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;        shared_port(-1) {</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;    }</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;    <span class="keywordtype">bool</span> IsValid()<span class="keyword"> const </span>{</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;        <span class="keywordflow">if</span> (shared_port &lt; 1)</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;        <span class="keywordflow">if</span> (!server_ports.IsValid())</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;        <span class="keywordflow">if</span> (client_ports.size() &lt; 1)</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;            <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;        <span class="keywordflow">for</span> (std::size_t i = 0; i &lt; client_ports.size(); ++i)</div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;            <span class="keywordflow">if</span> (!client_ports[i].IsValid())</div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;                <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;    }</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;};</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;</div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> max_path_size = 512;</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> max_version_size = 32;</div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> max_num_players = 16;</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;</div><div class="line"><a name="l00134"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_player_info.html">  134</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_replay_player_info.html">ReplayPlayerInfo</a> {</div><div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_player_info.html#a0a10ff4668dd1d3b017ff5d4da1837fc">  136</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structsc2_1_1_replay_player_info.html#a0a10ff4668dd1d3b017ff5d4da1837fc">player_id</a>;</div><div class="line"><a name="l00138"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_player_info.html#a0a1d671f0ad7727dcb2c9b4b4a2b9314">  138</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structsc2_1_1_replay_player_info.html#a0a1d671f0ad7727dcb2c9b4b4a2b9314">mmr</a>;</div><div class="line"><a name="l00140"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_player_info.html#aa9bd56433e96284ccf0b5107e03b1cf3">  140</a></span>&#160;    <span class="keywordtype">int</span> <a class="code" href="structsc2_1_1_replay_player_info.html#aa9bd56433e96284ccf0b5107e03b1cf3">apm</a>;</div><div class="line"><a name="l00142"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_player_info.html#a4ab3c2d0a8d9d784be2404c671f1d143">  142</a></span>&#160;    Race <a class="code" href="structsc2_1_1_replay_player_info.html#a4ab3c2d0a8d9d784be2404c671f1d143">race</a>;</div><div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_player_info.html#ad8061fc9f5910207eff1faa2437cdfae">  144</a></span>&#160;    Race <a class="code" href="structsc2_1_1_replay_player_info.html#ad8061fc9f5910207eff1faa2437cdfae">race_selected</a>;</div><div class="line"><a name="l00146"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_player_info.html#ad10393848e92ccfe4c2add12bd3528c5">  146</a></span>&#160;    GameResult <a class="code" href="structsc2_1_1_replay_player_info.html#ad10393848e92ccfe4c2add12bd3528c5">game_result</a>;</div><div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;</div><div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;    <a class="code" href="structsc2_1_1_replay_player_info.html">ReplayPlayerInfo</a>() :</div><div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;        player_id(0),</div><div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;        mmr(-10000),</div><div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;        apm(0),</div><div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;        race(Random),</div><div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;        race_selected(Random) {</div><div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;    }</div><div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;};</div><div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;</div><div class="line"><a name="l00158"></a><span class="lineno"><a class="line" href="structsc2_1_1_replay_info.html">  158</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structsc2_1_1_replay_info.html">ReplayInfo</a> {</div><div class="line"><a name="l00159"></a><span class="lineno">  159</span>&#160;    <span class="keywordtype">float</span> duration;</div><div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;    <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> duration_gameloops;</div><div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;    int32_t num_players;</div><div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;    uint32_t data_build;</div><div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;    uint32_t base_build;</div><div class="line"><a name="l00164"></a><span class="lineno">  164</span>&#160;    std::string map_name;</div><div class="line"><a name="l00165"></a><span class="lineno">  165</span>&#160;    std::string map_path;</div><div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;    std::string replay_path;</div><div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;    std::string version;</div><div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;    <a class="code" href="structsc2_1_1_replay_player_info.html">ReplayPlayerInfo</a> players[max_num_players];</div><div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;</div><div class="line"><a name="l00170"></a><span class="lineno">  170</span>&#160;    <a class="code" href="structsc2_1_1_replay_info.html">ReplayInfo</a>() :</div><div class="line"><a name="l00171"></a><span class="lineno">  171</span>&#160;        duration(0.0f),</div><div class="line"><a name="l00172"></a><span class="lineno">  172</span>&#160;        duration_gameloops(0),</div><div class="line"><a name="l00173"></a><span class="lineno">  173</span>&#160;        num_players(0),</div><div class="line"><a name="l00174"></a><span class="lineno">  174</span>&#160;        data_build(0),</div><div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;        base_build(0) {</div><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;    }</div><div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;</div><div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;    <span class="keywordtype">bool</span> GetPlayerInfo(<a class="code" href="structsc2_1_1_replay_player_info.html">ReplayPlayerInfo</a>&amp; replay_player_info, <span class="keywordtype">int</span> playerID)<span class="keyword"> const </span>{</div><div class="line"><a name="l00179"></a><span class="lineno">  179</span>&#160;        <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; num_players; ++i) {</div><div class="line"><a name="l00180"></a><span class="lineno">  180</span>&#160;            <span class="keywordflow">if</span> (playerID == players[i].player_id) {</div><div class="line"><a name="l00181"></a><span class="lineno">  181</span>&#160;                replay_player_info = players[i];</div><div class="line"><a name="l00182"></a><span class="lineno">  182</span>&#160;                <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00183"></a><span class="lineno">  183</span>&#160;            }</div><div class="line"><a name="l00184"></a><span class="lineno">  184</span>&#160;        }</div><div class="line"><a name="l00185"></a><span class="lineno">  185</span>&#160;</div><div class="line"><a name="l00186"></a><span class="lineno">  186</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">false</span>;</div><div class="line"><a name="l00187"></a><span class="lineno">  187</span>&#160;    }</div><div class="line"><a name="l00188"></a><span class="lineno">  188</span>&#160;</div><div class="line"><a name="l00189"></a><span class="lineno">  189</span>&#160;    <span class="keywordtype">float</span> GetGameloopsPerSecond()<span class="keyword"> const </span>{</div><div class="line"><a name="l00190"></a><span class="lineno">  190</span>&#160;        <span class="keywordflow">return</span> float(duration_gameloops) / duration;</div><div class="line"><a name="l00191"></a><span class="lineno">  191</span>&#160;    }</div><div class="line"><a name="l00192"></a><span class="lineno">  192</span>&#160;};</div><div class="line"><a name="l00193"></a><span class="lineno">  193</span>&#160;</div><div class="line"><a name="l00194"></a><span class="lineno">  194</span>&#160;}</div><div class="ttc" id="structsc2_1_1_replay_player_info_html_ad8061fc9f5910207eff1faa2437cdfae"><div class="ttname"><a href="structsc2_1_1_replay_player_info.html#ad8061fc9f5910207eff1faa2437cdfae">sc2::ReplayPlayerInfo::race_selected</a></div><div class="ttdeci">Race race_selected</div><div class="ttdoc">Selected player race. If the race is &quot;Random&quot;, the race data member may be different. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:144</div></div>
<div class="ttc" id="sc2__common_8h_html"><div class="ttname"><a href="sc2__common_8h.html">sc2_common.h</a></div><div class="ttdoc">Common data types, including points, rectangles and colors. </div></div>
<div class="ttc" id="structsc2_1_1_replay_player_info_html_aa9bd56433e96284ccf0b5107e03b1cf3"><div class="ttname"><a href="structsc2_1_1_replay_player_info.html#aa9bd56433e96284ccf0b5107e03b1cf3">sc2::ReplayPlayerInfo::apm</a></div><div class="ttdeci">int apm</div><div class="ttdoc">Player actions per minute. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:140</div></div>
<div class="ttc" id="structsc2_1_1_replay_info_html"><div class="ttname"><a href="structsc2_1_1_replay_info.html">sc2::ReplayInfo</a></div><div class="ttdoc">Information about a replay file. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:158</div></div>
<div class="ttc" id="namespacesc2_html"><div class="ttname"><a href="namespacesc2.html">sc2</a></div><div class="ttdef"><b>Definition:</b> sc2_action.h:9</div></div>
<div class="ttc" id="structsc2_1_1_ports_html"><div class="ttname"><a href="structsc2_1_1_ports.html">sc2::Ports</a></div><div class="ttdoc">Port setup for one or more clients in a game. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:105</div></div>
<div class="ttc" id="structsc2_1_1_player_setup_html_ac9616c686e3e31c2d8f9f023c9cd7dca"><div class="ttname"><a href="structsc2_1_1_player_setup.html#ac9616c686e3e31c2d8f9f023c9cd7dca">sc2::PlayerSetup::difficulty</a></div><div class="ttdeci">Difficulty difficulty</div><div class="ttdoc">Difficulty: Only for playing against the built-in AI. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:63</div></div>
<div class="ttc" id="structsc2_1_1_port_set_html"><div class="ttname"><a href="structsc2_1_1_port_set.html">sc2::PortSet</a></div><div class="ttdoc">Port setup for a client. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:90</div></div>
<div class="ttc" id="structsc2_1_1_replay_player_info_html"><div class="ttname"><a href="structsc2_1_1_replay_player_info.html">sc2::ReplayPlayerInfo</a></div><div class="ttdoc">Information about a player in a replay. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:134</div></div>
<div class="ttc" id="structsc2_1_1_replay_player_info_html_ad10393848e92ccfe4c2add12bd3528c5"><div class="ttname"><a href="structsc2_1_1_replay_player_info.html#ad10393848e92ccfe4c2add12bd3528c5">sc2::ReplayPlayerInfo::game_result</a></div><div class="ttdeci">GameResult game_result</div><div class="ttdoc">If the player won or lost. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:146</div></div>
<div class="ttc" id="structsc2_1_1_replay_player_info_html_a0a10ff4668dd1d3b017ff5d4da1837fc"><div class="ttname"><a href="structsc2_1_1_replay_player_info.html#a0a10ff4668dd1d3b017ff5d4da1837fc">sc2::ReplayPlayerInfo::player_id</a></div><div class="ttdeci">int player_id</div><div class="ttdoc">Player ID. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:136</div></div>
<div class="ttc" id="structsc2_1_1_player_setup_html_a46fd53bd97da279d423345b454823f2e"><div class="ttname"><a href="structsc2_1_1_player_setup.html#a46fd53bd97da279d423345b454823f2e">sc2::PlayerSetup::agent</a></div><div class="ttdeci">Agent * agent</div><div class="ttdoc">Agent, if one is available. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:56</div></div>
<div class="ttc" id="structsc2_1_1_replay_player_info_html_a0a1d671f0ad7727dcb2c9b4b4a2b9314"><div class="ttname"><a href="structsc2_1_1_replay_player_info.html#a0a1d671f0ad7727dcb2c9b4b4a2b9314">sc2::ReplayPlayerInfo::mmr</a></div><div class="ttdeci">int mmr</div><div class="ttdoc">Player ranking. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:138</div></div>
<div class="ttc" id="structsc2_1_1_player_setup_html_aaa5c79519707f78fbe6f9f6d3580a051"><div class="ttname"><a href="structsc2_1_1_player_setup.html#aaa5c79519707f78fbe6f9f6d3580a051">sc2::PlayerSetup::race</a></div><div class="ttdeci">Race race</div><div class="ttdoc">Race: Terran, Zerg or Protoss. Only for playing against the built-in AI. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:61</div></div>
<div class="ttc" id="structsc2_1_1_player_setup_html"><div class="ttname"><a href="structsc2_1_1_player_setup.html">sc2::PlayerSetup</a></div><div class="ttdoc">Setup for a player in a game. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:52</div></div>
<div class="ttc" id="structsc2_1_1_player_setup_html_a59ec60d77794e16f2325a4bdbc693d89"><div class="ttname"><a href="structsc2_1_1_player_setup.html#a59ec60d77794e16f2325a4bdbc693d89">sc2::PlayerSetup::type</a></div><div class="ttdeci">PlayerType type</div><div class="ttdoc">Player can be a Participant (usually an agent), Computer (in-built AI) or Observer. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:54</div></div>
<div class="ttc" id="classsc2_1_1_agent_html"><div class="ttname"><a href="classsc2_1_1_agent.html">sc2::Agent</a></div><div class="ttdoc">The base class for user defined bots. </div><div class="ttdef"><b>Definition:</b> sc2_agent.h:22</div></div>
<div class="ttc" id="structsc2_1_1_replay_player_info_html_a4ab3c2d0a8d9d784be2404c671f1d143"><div class="ttname"><a href="structsc2_1_1_replay_player_info.html#a4ab3c2d0a8d9d784be2404c671f1d143">sc2::ReplayPlayerInfo::race</a></div><div class="ttdeci">Race race</div><div class="ttdoc">Actual player race. </div><div class="ttdef"><b>Definition:</b> sc2_gametypes.h:142</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
